/******************************************************************************
 * Copyright (c) 2011, S. Kyle Korndoerfer
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 *  * Redistributions of source code must retain the above copyright notice, 
 *      this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the 
 *      documentation and/or other materials provided with the distribution.
 *  * Neither the name of KyKo Software nor the names of its contributors may 
 *      be used to endorse or promote products derived from this software 
 *      without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 * POSSIBILITY OF SUCH DAMAGE. 
 *****************************************************************************/

using System;
using System.Net;

namespace WebSequenceDiagrams
{
	/// <summary>
	///		Defines the contract for the Web Sequence Diagram web service.
	/// </summary>
	public interface IService
	{
		/// <summary>
		///     Event that is raised once the response from the service has
		///     been received.
		/// </summary>
		event EventHandler<DownloadCompleteEventArgs> DownloadComplete;

		/// <summary>
		///     Gets the data from the service using the supplied parameters.
		/// </summary>
		/// <param name="style">The style used to render the diagram.</param>
		/// <param name="scale">The scale to generate the diagram in.</param>
		/// <param name="message">The sequence text to generate the diagram
		///     from.</param>
		/// <param name="proxy">The proxy settings to use (if needed).</param>
		void GetSequenceDiagram( string style, string scale, string message, IWebProxy proxy );
	}
}